/*
 * Copyright 2007 Matt Jensen
 *
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
 * the License. You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
 * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
 * specific language governing permissions and limitations under the License.
 */
package org.jtell;

import org.jtell.config.EventSinkMetadata;

import java.util.Set;

/**
 * <p>
 * <code>EventSinkSource</code> defines the public interface to an event sink source. An event channel uses one or more
 * event sink sources to combine application listener objects with configuration metadata to create {@link EventSink}
 * objects. The event sink objects act as the interface between JTell and the application listener objects.
 * </p>
 */
public interface EventSinkSource
{
    /**
     * <p>
     * Create the appropriate event sinks for an application listener object, possibly consulting with a set of supplied
     * metadata objects describing the available event sinks.
     * </p>
     *
     * @param listener the application listener object.
     * @param metadata the event sink metadata objects.
     * @return {@link Set} of {@link EventSink} instances.
     */
    Set<EventSink> getEventSinks(Object listener, Set<EventSinkMetadata> metadata);
}
